Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #78

Merged
merged 9 commits into from
Dec 12, 2023
Merged

Docs #78

merged 9 commits into from
Dec 12, 2023

Conversation

nastena1606
Copy link
Collaborator

No description provided.

Copy link

github-actions bot commented Nov 29, 2023

Performance test results:
Normal queries: 9152
TDE queries: 8069
Percentage: 88%

README.md Show resolved Hide resolved
documentation/docs/index.md Outdated Show resolved Hide resolved
documentation/docs/index.md Outdated Show resolved Hide resolved
documentation/docs/test.md Outdated Show resolved Hide resolved
In the MVP version of `pg_tde`, the following remains unencrypted:

* Indexes
* Logical replication
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Logical replication just doesn't work.

Logical replication uses WAL. As WAL is encrypted, logical replication routines are unable to de/en_crypt it properly to communicate data. This is something to be done after the MVP.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nastena1606 could you add this is a "limitations" section or something similar?

documentation/docs/index.md Outdated Show resolved Hide resolved
documentation/docs/install.md Outdated Show resolved Hide resolved
documentation/docs/index.md Outdated Show resolved Hide resolved
documentation/docs/index.md Outdated Show resolved Hide resolved
documentation/docs/install.md Outdated Show resolved Hide resolved
documentation/docs/setup.md Outdated Show resolved Hide resolved
documentation/docs/setup.md Outdated Show resolved Hide resolved
documentation/docs/tde.md Outdated Show resolved Hide resolved
documentation/docs/test.md Outdated Show resolved Hide resolved
documentation/docs/test.md Show resolved Hide resolved
documentation/docs/uninstall.md Outdated Show resolved Hide resolved

```sh
sudo systemctl restart postgresql-16
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At this point, the keyring configuration can be deleted too, and if keyring file is used, the datafile too.

Added flow diagram
Added contributing doc
Copy link
Collaborator

@ImTheKai ImTheKai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM


Before submitting code contributions, we ask you to complete the following prerequisites.

### 1. Sign the CLA
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't have CLA assistant set up for the tde ext. @capri1989 Do we want to?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes we want to have one and comply with all other projects that we're having.

In the MVP version of `pg_tde`, the following remains unencrypted:

* Indexes
* Logical replication
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nastena1606 could you add this is a "limitations" section or something similar?


=== "Package manager"

Currently only DEB packages are available. If you are running RPM-based operating system, consider [building the extension from source](#build-from-source) or [running it in Docker](#run-in-docker)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deb packages are built for ubuntu 22.04, other distributions / versions might or might not work.

@@ -0,0 +1,165 @@
# Contributing guide
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add a link to the Make Build developers docs: https://github.com/Percona-Lab/postgres-tde-ext/wiki/Make-builds-for-developers somewhere? Or just mention the WIKI in general as it expected to get more pages in future.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Plus we'd probably want to mention that the project should follow Postgres' coding conventions (https://www.postgresql.org/docs/current/source.html). Although we don't follow them on our own. But have such intention)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added. A question about tests - do we have them? Where to point contributors to?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do have tests. To run them:

./configure
make USE_PGXS=1 installcheck

@ImTheKai ImTheKai merged commit b015863 into main Dec 12, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants